<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfdDirectory</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.0">
<link rel="home" href="index.html" title="libinfinity-0.4 Reference Manual">
<link rel="up" href="ch05.html" title="Libinfinity server side API">
<link rel="prev" href="ch05.html" title="Libinfinity server side API">
<link rel="next" href="libinfinity-0.4-InfdNotePlugin.html" title="InfdNotePlugin">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch05.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch05.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinfinity-0.4 Reference Manual</th>
<td><a accesskey="n" href="libinfinity-0.4-InfdNotePlugin.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfdDirectory.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#InfdDirectory.description" class="shortcut">Description</a>
                   | 
                  <a href="#InfdDirectory.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#InfdDirectory.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#InfdDirectory.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#InfdDirectory.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="InfdDirectory">
<a name="InfdDirectory"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfdDirectory.top_of_page"></a>InfdDirectory</span></h2>
<p>InfdDirectory — Directory of published documents</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="InfdDirectory.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="InfdDirectory.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libinfinity/server/infd-directory.h&gt;

                    <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter">InfdDirectoryIter</a>;
                    <a class="link" href="InfdDirectory.html#InfdDirectory-struct" title="InfdDirectory">InfdDirectory</a>;
                    <a class="link" href="InfdDirectory.html#InfdDirectoryClass" title="InfdDirectoryClass">InfdDirectoryClass</a>;
<a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="returnvalue">InfdDirectoryIter</span></a> * <a class="link" href="InfdDirectory.html#infd-directory-iter-copy" title="infd_directory_iter_copy ()">infd_directory_iter_copy</a>            (<em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfdDirectory.html#infd-directory-iter-free" title="infd_directory_iter_free ()">infd_directory_iter_free</a>            (<em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);
<a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="returnvalue">InfdDirectory</span></a> *     <a class="link" href="InfdDirectory.html#infd-directory-new" title="infd_directory_new ()">infd_directory_new</a>                  (<em class="parameter"><code><a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> *io</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libinfinity-0.4-infd-storage.html#InfdStorage"><span class="type">InfdStorage</span></a> *storage</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *comm_manager</code></em>);
<a class="link" href="InfIo.html" title="InfIo"><span class="returnvalue">InfIo</span></a> *             <a class="link" href="InfdDirectory.html#infd-directory-get-io" title="infd_directory_get_io ()">infd_directory_get_io</a>               (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>);
<a class="link" href="libinfinity-0.4-infd-storage.html#InfdStorage"><span class="returnvalue">InfdStorage</span></a> *       <a class="link" href="InfdDirectory.html#infd-directory-get-storage" title="infd_directory_get_storage ()">infd_directory_get_storage</a>          (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>);
<a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="returnvalue">InfCommunicationManager</span></a> * <a class="link" href="InfdDirectory.html#infd-directory-get-communication-manager" title="infd_directory_get_communication_manager ()">infd_directory_get_communication_manager</a>
                                                        (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfdDirectory.html#infd-directory-add-plugin" title="infd_directory_add_plugin ()">infd_directory_add_plugin</a>           (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="libinfinity-0.4-InfdNotePlugin.html#InfdNotePlugin" title="InfdNotePlugin"><span class="type">InfdNotePlugin</span></a> *plugin</code></em>);
const <a class="link" href="libinfinity-0.4-InfdNotePlugin.html#InfdNotePlugin" title="InfdNotePlugin"><span class="returnvalue">InfdNotePlugin</span></a> * <a class="link" href="InfdDirectory.html#infd-directory-lookup-plugin" title="infd_directory_lookup_plugin ()">infd_directory_lookup_plugin</a>     (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *note_type</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfdDirectory.html#infd-directory-add-connection" title="infd_directory_add_connection ()">infd_directory_add_connection</a>       (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="InfdDirectory.html#infd-directory-iter-get-name" title="infd_directory_iter_get_name ()">infd_directory_iter_get_name</a>        (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="InfdDirectory.html#infd-directory-iter-get-path" title="infd_directory_iter_get_path ()">infd_directory_iter_get_path</a>        (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfdDirectory.html#infd-directory-iter-get-root" title="infd_directory_iter_get_root ()">infd_directory_iter_get_root</a>        (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfdDirectory.html#infd-directory-iter-get-next" title="infd_directory_iter_get_next ()">infd_directory_iter_get_next</a>        (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfdDirectory.html#infd-directory-iter-get-prev" title="infd_directory_iter_get_prev ()">infd_directory_iter_get_prev</a>        (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfdDirectory.html#infd-directory-iter-get-parent" title="infd_directory_iter_get_parent ()">infd_directory_iter_get_parent</a>      (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfdDirectory.html#infd-directory-iter-get-child" title="infd_directory_iter_get_child ()">infd_directory_iter_get_child</a>       (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfdDirectory.html#infd-directory-iter-get-explored" title="infd_directory_iter_get_explored ()">infd_directory_iter_get_explored</a>    (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfdDirectory.html#infd-directory-add-subdirectory" title="infd_directory_add_subdirectory ()">infd_directory_add_subdirectory</a>     (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *parent</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfdDirectory.html#infd-directory-add-note" title="infd_directory_add_note ()">infd_directory_add_note</a>             (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *parent</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="libinfinity-0.4-InfdNotePlugin.html#InfdNotePlugin" title="InfdNotePlugin"><span class="type">InfdNotePlugin</span></a> *plugin</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfdDirectory.html#infd-directory-remove-node" title="infd_directory_remove_node ()">infd_directory_remove_node</a>          (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a class="link" href="libinfinity-0.4-infd-storage.html#InfdStorageNodeType" title="enum InfdStorageNodeType"><span class="returnvalue">InfdStorageNodeType</span></a>  <a class="link" href="InfdDirectory.html#infd-directory-iter-get-node-type" title="infd_directory_iter_get_node_type ()">infd_directory_iter_get_node_type</a>  (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);
const <a class="link" href="libinfinity-0.4-InfdNotePlugin.html#InfdNotePlugin" title="InfdNotePlugin"><span class="returnvalue">InfdNotePlugin</span></a> * <a class="link" href="InfdDirectory.html#infd-directory-iter-get-plugin" title="infd_directory_iter_get_plugin ()">infd_directory_iter_get_plugin</a>   (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);
<a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="returnvalue">InfdSessionProxy</span></a> *  <a class="link" href="InfdDirectory.html#infd-directory-iter-get-session" title="infd_directory_iter_get_session ()">infd_directory_iter_get_session</a>     (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="returnvalue">InfdSessionProxy</span></a> *  <a class="link" href="InfdDirectory.html#infd-directory-iter-peek-session" title="infd_directory_iter_peek_session ()">infd_directory_iter_peek_session</a>    (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfdDirectory.html#infd-directory-iter-save-session" title="infd_directory_iter_save_session ()">infd_directory_iter_save_session</a>    (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfdDirectory.html#infd-directory-enable-chat" title="infd_directory_enable_chat ()">infd_directory_enable_chat</a>          (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enable</code></em>);
<a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="returnvalue">InfdSessionProxy</span></a> *  <a class="link" href="InfdDirectory.html#infd-directory-get-chat-session" title="infd_directory_get_chat_session ()">infd_directory_get_chat_session</a>     (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="InfdDirectory.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----InfdDirectory
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="InfdDirectory.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
InfdDirectory implements
 <a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject">InfCommunicationObject</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="InfdDirectory.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="InfdDirectory.html#InfdDirectory--chat-session" title='The "chat-session" property'>chat-session</a>"             <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a>*     : Read
  "<a class="link" href="InfdDirectory.html#InfdDirectory--communication-manager" title='The "communication-manager" property'>communication-manager</a>"    <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>*  : Read / Write / Construct Only
  "<a class="link" href="InfdDirectory.html#InfdDirectory--io" title='The "io" property'>io</a>"                       <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a>*                : Read / Write / Construct Only
  "<a class="link" href="InfdDirectory.html#InfdDirectory--storage" title='The "storage" property'>storage</a>"                  <a class="link" href="libinfinity-0.4-infd-storage.html#InfdStorage"><span class="type">InfdStorage</span></a>*          : Read / Write / Construct
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="InfdDirectory.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="InfdDirectory.html#InfdDirectory-add-session" title='The "add-session" signal'>add-session</a>"                                    : Run Last
  "<a class="link" href="InfdDirectory.html#InfdDirectory-node-added" title='The "node-added" signal'>node-added</a>"                                     : Run Last
  "<a class="link" href="InfdDirectory.html#InfdDirectory-node-removed" title='The "node-removed" signal'>node-removed</a>"                                   : Run Last
  "<a class="link" href="InfdDirectory.html#InfdDirectory-remove-session" title='The "remove-session" signal'>remove-session</a>"                                 : Run Last
</pre>
</div>
<div class="refsect1" title="Description">
<a name="InfdDirectory.description"></a><h2>Description</h2>
<p>
The <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> manages a directory of documents. An item in the
directory is also called "node". A node may either be a
subdirectory or a document (also called "note"). Notes may be of
different type - there may be plain text notes, rich text notes,
graphics notes, etc.
</p>
<p>
<a class="link" href="libinfinity-0.4-infd-storage.html#InfdStorage"><span class="type">InfdStorage</span></a> defines where the directory structure and the notes are read
from and how there are permanently stored.
</p>
</div>
<div class="refsect1" title="Details">
<a name="InfdDirectory.details"></a><h2>Details</h2>
<div class="refsect2" title="InfdDirectoryIter">
<a name="InfdDirectoryIter"></a><h3>InfdDirectoryIter</h3>
<pre class="programlisting">typedef struct {
  guint node_id;
  gpointer node;
} InfdDirectoryIter;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="InfdDirectory">
<a name="InfdDirectory-struct"></a><h3>InfdDirectory</h3>
<pre class="programlisting">typedef struct _InfdDirectory InfdDirectory;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="InfdDirectoryClass">
<a name="InfdDirectoryClass"></a><h3>InfdDirectoryClass</h3>
<pre class="programlisting">typedef struct {
  GObjectClass parent_class;

  /* Signals */
  void (*node_added)(InfdDirectory* directory,
                     InfdDirectoryIter* iter);

  void (*node_removed)(InfdDirectory* directory,
                       InfdDirectoryIter* iter);

  void (*add_session)(InfdDirectory* directory,
                      InfdDirectoryIter* iter,
                      InfdSessionProxy* session);

  void (*remove_session)(InfdDirectory* directory,
                         InfdDirectoryIter* iter,
                         InfdSessionProxy* session);
} InfdDirectoryClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="infd_directory_iter_copy ()">
<a name="infd-directory-iter-copy"></a><h3>infd_directory_iter_copy ()</h3>
<pre class="programlisting"><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="returnvalue">InfdDirectoryIter</span></a> * infd_directory_iter_copy            (<em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);</pre>
<p>
Makes a dynamically-allocated copy of <em class="parameter"><code>iter</code></em>. This should not be used by
applications because you can copy the structs by value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A newly-allocated copy of <em class="parameter"><code>iter</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_iter_free ()">
<a name="infd-directory-iter-free"></a><h3>infd_directory_iter_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                infd_directory_iter_free            (<em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);</pre>
<p>
Frees a <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> allocated with <a class="link" href="InfdDirectory.html#infd-directory-iter-copy" title="infd_directory_iter_copy ()"><code class="function">infd_directory_iter_copy()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_new ()">
<a name="infd-directory-new"></a><h3>infd_directory_new ()</h3>
<pre class="programlisting"><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="returnvalue">InfdDirectory</span></a> *     infd_directory_new                  (<em class="parameter"><code><a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> *io</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libinfinity-0.4-infd-storage.html#InfdStorage"><span class="type">InfdStorage</span></a> *storage</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *comm_manager</code></em>);</pre>
<p>
Creates a new <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>io</code></em> :</span></p></td>
<td>IO object to watch connections and schedule timeouts.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>storage</code></em> :</span></p></td>
<td>Storage backend that is used to read/write notes from
permanent memory into <a class="link" href="InfBuffer.html" title="InfBuffer"><span class="type">InfBuffer</span></a> objects.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>comm_manager</code></em> :</span></p></td>
<td>A <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> to register added
connections to and which forwards incoming data to the directory
or running sessions.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A new <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_get_io ()">
<a name="infd-directory-get-io"></a><h3>infd_directory_get_io ()</h3>
<pre class="programlisting"><a class="link" href="InfIo.html" title="InfIo"><span class="returnvalue">InfIo</span></a> *             infd_directory_get_io               (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>);</pre>
<p>
Returns the IO object in use by the directory.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_get_storage ()">
<a name="infd-directory-get-storage"></a><h3>infd_directory_get_storage ()</h3>
<pre class="programlisting"><a class="link" href="libinfinity-0.4-infd-storage.html#InfdStorage"><span class="returnvalue">InfdStorage</span></a> *       infd_directory_get_storage          (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>);</pre>
<p>
Returns the storage backend in use by the directory.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>:
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> An <span class="type">InfdDirectoryStorage</span>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_get_communication_manager ()">
<a name="infd-directory-get-communication-manager"></a><h3>infd_directory_get_communication_manager ()</h3>
<pre class="programlisting"><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="returnvalue">InfCommunicationManager</span></a> * infd_directory_get_communication_manager
                                                        (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>);</pre>
<p>
Returns the connection manager of the directory.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> An <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_add_plugin ()">
<a name="infd-directory-add-plugin"></a><h3>infd_directory_add_plugin ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            infd_directory_add_plugin           (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="libinfinity-0.4-InfdNotePlugin.html#InfdNotePlugin" title="InfdNotePlugin"><span class="type">InfdNotePlugin</span></a> *plugin</code></em>);</pre>
<p>
Adds <em class="parameter"><code>plugin</code></em> to <em class="parameter"><code>directory</code></em>. This allows the directory to create sessions
of the plugin's type. Only one plugin of each type can be added to the
directory. The plugin's storage_type must match the storage of <em class="parameter"><code>directory</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
<td>A <a class="link" href="libinfinity-0.4-InfdNotePlugin.html#InfdNotePlugin" title="InfdNotePlugin"><span class="type">InfdNotePlugin</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Whether the plugin was added successfully.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_lookup_plugin ()">
<a name="infd-directory-lookup-plugin"></a><h3>infd_directory_lookup_plugin ()</h3>
<pre class="programlisting">const <a class="link" href="libinfinity-0.4-InfdNotePlugin.html#InfdNotePlugin" title="InfdNotePlugin"><span class="returnvalue">InfdNotePlugin</span></a> * infd_directory_lookup_plugin     (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *note_type</code></em>);</pre>
<p>
Returns the <a class="link" href="libinfinity-0.4-InfdNotePlugin.html#InfdNotePlugin" title="InfdNotePlugin"><span class="type">InfdNotePlugin</span></a> that handles the given note type, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
in case no corresponding plugin was added.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>note_type</code></em> :</span></p></td>
<td>A note type for which to lookup the plugin.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a class="link" href="libinfinity-0.4-InfdNotePlugin.html#InfdNotePlugin" title="InfdNotePlugin"><span class="type">InfdNotePlugin</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_add_connection ()">
<a name="infd-directory-add-connection"></a><h3>infd_directory_add_connection ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            infd_directory_add_connection       (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);</pre>
<p>
Adds <em class="parameter"><code>connection</code></em> to the connections of <em class="parameter"><code>directory</code></em>. The directory will then
receive requests from <em class="parameter"><code>connection</code></em>. If the directory's method manager does
not contain a "central" method for connection's network, then the
connection will not be added and the function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>A <span class="type">InfConnection</span>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Whether the connection was added to the directory.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_iter_get_name ()">
<a name="infd-directory-iter-get-name"></a><h3>infd_directory_iter_get_name ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       infd_directory_iter_get_name        (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);</pre>
<p>
Returns the name of the node <em class="parameter"><code>iter</code></em> points to.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to a node in <em class="parameter"><code>directory</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The node's name. The returned string must not be freed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_iter_get_path ()">
<a name="infd-directory-iter-get-path"></a><h3>infd_directory_iter_get_path ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             infd_directory_iter_get_path        (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);</pre>
<p>
Returns the complete path to the node <em class="parameter"><code>iter</code></em> points to. The path to a node
is the name of the node and the name of all parent nodes separated by '/',
as a filesystem path on Unix.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to a node in <em class="parameter"><code>directory</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The node's path. Free with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer in use.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_iter_get_root ()">
<a name="infd-directory-iter-get-root"></a><h3>infd_directory_iter_get_root ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                infd_directory_iter_get_root        (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);</pre>
<p>
Sets <em class="parameter"><code>iter</code></em> to point to the root node of the directory.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>An uninitalized <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_iter_get_next ()">
<a name="infd-directory-iter-get-next"></a><h3>infd_directory_iter_get_next ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            infd_directory_iter_get_next        (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);</pre>
<p>
Sets <em class="parameter"><code>iter</code></em> to point to the next node within the same subdirectory. If there
is no next node, <em class="parameter"><code>iter</code></em> is left untouched and the function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to some node in <em class="parameter"><code>directory</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, if <em class="parameter"><code>iter</code></em> was set. 
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_iter_get_prev ()">
<a name="infd-directory-iter-get-prev"></a><h3>infd_directory_iter_get_prev ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            infd_directory_iter_get_prev        (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);</pre>
<p>
Sets <em class="parameter"><code>iter</code></em> to point to the previous node within the same subdirectory. If
there is no such node, <em class="parameter"><code>iter</code></em> is left untouched and the function returns
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to some node in <em class="parameter"><code>directory</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, if <em class="parameter"><code>iter</code></em> was set. 
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_iter_get_parent ()">
<a name="infd-directory-iter-get-parent"></a><h3>infd_directory_iter_get_parent ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            infd_directory_iter_get_parent      (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);</pre>
<p>
Sets <em class="parameter"><code>iter</code></em> to point to the parent node of <em class="parameter"><code>iter</code></em>. This node is guaranteed
to be a subdirectory node. If there is no such node (i.e. <em class="parameter"><code>iter</code></em> points
to the root node), <em class="parameter"><code>iter</code></em> is left untouched and the function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to some node in <em class="parameter"><code>directory</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, if <em class="parameter"><code>iter</code></em> was set. 
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_iter_get_child ()">
<a name="infd-directory-iter-get-child"></a><h3>infd_directory_iter_get_child ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            infd_directory_iter_get_child       (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Sets <em class="parameter"><code>iter</code></em> to point to first child node of <em class="parameter"><code>iter</code></em>. This requires that <em class="parameter"><code>iter</code></em>
points to a subdirectory node. If the subdirectory <em class="parameter"><code>iter</code></em> points to has
no children, the function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and <em class="parameter"><code>iter</code></em> is left untouched.
</p>
<p>
The function might fail if this node's children have not yet been read
from the background storage and an error occurs while reading them. In
this case, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em> is set.
</p>
<p>
The function guarantees not to set <em class="parameter"><code>error</code></em> if the node is already explored,
i.e. <a class="link" href="InfdDirectory.html#infd-directory-iter-get-explored" title="infd_directory_iter_get_explored ()"><code class="function">infd_directory_iter_get_explored()</code></a> returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for <em class="parameter"><code>directory</code></em> and
<em class="parameter"><code>iter</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to a subdirectory node in <em class="parameter"><code>directory</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Location to store error information.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, if <em class="parameter"><code>iter</code></em> was set. 
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_iter_get_explored ()">
<a name="infd-directory-iter-get-explored"></a><h3>infd_directory_iter_get_explored ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            infd_directory_iter_get_explored    (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);</pre>
<p>
Returns whether the subdirectory node pointed to by <em class="parameter"><code>iter</code></em> has already
been read from the background storage. If not, then no connections can
be subscribed to any child nodes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to a subdirectory node in <em class="parameter"><code>directory</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Whether the node <em class="parameter"><code>iter</code></em> points to has been explored.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_add_subdirectory ()">
<a name="infd-directory-add-subdirectory"></a><h3>infd_directory_add_subdirectory ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            infd_directory_add_subdirectory     (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *parent</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Adds a subdirectory to the directory tree. The new subdirectory will be
a child the subdirectory <em class="parameter"><code>parent</code></em> points to. <em class="parameter"><code>iter</code></em> is modified to point to
the new subdirectory. If creation fails, the function returns FALSE and
<em class="parameter"><code>error</code></em> is set.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to a subdirectory node
in <em class="parameter"><code>directory</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The name of the new node.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>An uninitalized <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Location to store error information.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the subdirectory was created successfully.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_add_note ()">
<a name="infd-directory-add-note"></a><h3>infd_directory_add_note ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            infd_directory_add_note             (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *parent</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="libinfinity-0.4-InfdNotePlugin.html#InfdNotePlugin" title="InfdNotePlugin"><span class="type">InfdNotePlugin</span></a> *plugin</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Creates a new note in <em class="parameter"><code>directory</code></em>. It will be child of the subdirectory
node <em class="parameter"><code>parent</code></em> points to. <em class="parameter"><code>iter</code></em> is set to point to the new node. If an
error occurs, the function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and <em class="parameter"><code>error</code></em> is set.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to a subdirectory node
in <em class="parameter"><code>directory</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The name of the new node.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
<td>The plugin to use for the node. Must have been added with
<a class="link" href="InfdDirectory.html#infd-directory-add-plugin" title="infd_directory_add_plugin ()"><code class="function">infd_directory_add_plugin()</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>An uninitialized <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Location to store error information.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_remove_node ()">
<a name="infd-directory-remove-node"></a><h3>infd_directory_remove_node ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            infd_directory_remove_node          (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Removes the node <em class="parameter"><code>iter</code></em> points to. If it is a subdirectory node, every
node it contains will also be removed. If the function fails, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is
returned and <em class="parameter"><code>error</code></em> is set.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to some node in <em class="parameter"><code>directory</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Location to store error information.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_iter_get_node_type ()">
<a name="infd-directory-iter-get-node-type"></a><h3>infd_directory_iter_get_node_type ()</h3>
<pre class="programlisting"><a class="link" href="libinfinity-0.4-infd-storage.html#InfdStorageNodeType" title="enum InfdStorageNodeType"><span class="returnvalue">InfdStorageNodeType</span></a>  infd_directory_iter_get_node_type  (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);</pre>
<p>
Returns the type of the node <em class="parameter"><code>iter</code></em> points to.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to some node in <em class="parameter"><code>directory</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <span class="type">InfdDirectoryStorageNodeType</span>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_iter_get_plugin ()">
<a name="infd-directory-iter-get-plugin"></a><h3>infd_directory_iter_get_plugin ()</h3>
<pre class="programlisting">const <a class="link" href="libinfinity-0.4-InfdNotePlugin.html#InfdNotePlugin" title="InfdNotePlugin"><span class="returnvalue">InfdNotePlugin</span></a> * infd_directory_iter_get_plugin   (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);</pre>
<p>
Returns the plugin that is used to create a session for the note <em class="parameter"><code>iter</code></em>
points to.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>a <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to a note in <em class="parameter"><code>directory</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The plugin for the note <em class="parameter"><code>iter</code></em> points to.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_iter_get_session ()">
<a name="infd-directory-iter-get-session"></a><h3>infd_directory_iter_get_session ()</h3>
<pre class="programlisting"><a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="returnvalue">InfdSessionProxy</span></a> *  infd_directory_iter_get_session     (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Returns the running session in which the note <em class="parameter"><code>iter</code></em> points to is currently
edited. If the session does not exist, it is created. However, this might
fail if the loading from the background storage fails. In this case, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
is returned and <em class="parameter"><code>error</code></em> is set.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to a note in <em class="parameter"><code>directory</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Location to store error information.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> for the note <em class="parameter"><code>iter</code></em> points to.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_iter_peek_session ()">
<a name="infd-directory-iter-peek-session"></a><h3>infd_directory_iter_peek_session ()</h3>
<pre class="programlisting"><a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="returnvalue">InfdSessionProxy</span></a> *  infd_directory_iter_peek_session    (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>);</pre>
<p>
Returns the running session in which the note <em class="parameter"><code>iter</code></em> points to is currently
edited. If the session does not exist because nobody is editing it at the
moment, the function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to a note in <em class="parameter"><code>directory</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> for the note <em class="parameter"><code>iter</code></em> points to, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_iter_save_session ()">
<a name="infd-directory-iter-save-session"></a><h3>infd_directory_iter_save_session ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            infd_directory_iter_save_session    (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Attempts to store the session the node <em class="parameter"><code>iter</code></em> points to represents into the
background storage.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to a note in <em class="parameter"><code>directory</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Location to store error information.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the operation succeeded, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_enable_chat ()">
<a name="infd-directory-enable-chat"></a><h3>infd_directory_enable_chat ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                infd_directory_enable_chat          (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enable</code></em>);</pre>
<p>
If <em class="parameter"><code>enable</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, this enables the chat on the server. This allows
clients subscribing to the chat via <a class="link" href="InfcBrowser.html#infc-browser-subscribe-chat" title="infc_browser_subscribe_chat ()"><code class="function">infc_browser_subscribe_chat()</code></a>. If
<em class="parameter"><code>enable</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> the chat is disabled which means closing an existing
chat session if any and no longer allowing subscription to the chat.
The chat is initially disabled.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>enable</code></em> :</span></p></td>
<td>Whether to enable or disable the chat.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_directory_get_chat_session ()">
<a name="infd-directory-get-chat-session"></a><h3>infd_directory_get_chat_session ()</h3>
<pre class="programlisting"><a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="returnvalue">InfdSessionProxy</span></a> *  infd_directory_get_chat_session     (<em class="parameter"><code><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> *directory</code></em>);</pre>
<p>
Returns a <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> for the chat session, if any. If the chat is
enabled (see <a class="link" href="InfdDirectory.html#infd-directory-enable-chat" title="infd_directory_enable_chat ()"><code class="function">infd_directory_enable_chat()</code></a>) this returns a <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a>
that can be used to join local users to the chat, or to get chat contents
(by getting the <a class="link" href="InfChatBuffer.html" title="InfChatBuffer"><span class="type">InfChatBuffer</span></a> from the proxy's <a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a>). If the
chat is disabled the function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the chat is disabled.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="InfdDirectory.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "chat-session" property'>
<a name="InfdDirectory--chat-session"></a><h3>The <code class="literal">"chat-session"</code> property</h3>
<pre class="programlisting">  "chat-session"             <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a>*     : Read</pre>
<p>The server's chat session.</p>
</div>
<hr>
<div class="refsect2" title='The "communication-manager" property'>
<a name="InfdDirectory--communication-manager"></a><h3>The <code class="literal">"communication-manager"</code> property</h3>
<pre class="programlisting">  "communication-manager"    <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>*  : Read / Write / Construct Only</pre>
<p>The communication manager for the directory.</p>
</div>
<hr>
<div class="refsect2" title='The "io" property'>
<a name="InfdDirectory--io"></a><h3>The <code class="literal">"io"</code> property</h3>
<pre class="programlisting">  "io"                       <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a>*                : Read / Write / Construct Only</pre>
<p>IO object to watch sockets and schedule timeouts.</p>
</div>
<hr>
<div class="refsect2" title='The "storage" property'>
<a name="InfdDirectory--storage"></a><h3>The <code class="literal">"storage"</code> property</h3>
<pre class="programlisting">  "storage"                  <a class="link" href="libinfinity-0.4-infd-storage.html#InfdStorage"><span class="type">InfdStorage</span></a>*          : Read / Write / Construct</pre>
<p>The storage backend to use.</p>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="InfdDirectory.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "add-session" signal'>
<a name="InfdDirectory-add-session"></a><h3>The <code class="literal">"add-session"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>     *directory,
                                                        <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter,
                                                        <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a>  *session,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>           user_data)      : Run Last</pre>
<p>
This signal is emitted, when a session has been associated with a node.
This happens when <a class="link" href="InfdDirectory.html#infd-directory-iter-get-session" title="infd_directory_iter_get_session ()"><code class="function">infd_directory_iter_get_session()</code></a> is called on a node,
when a remote client subscribes to a session or a new node was created.
</p>
<p>
When a session has been created for a node, the session is kept until it
is idle for some time. Then, it is removed again after having been stored
into the background storage.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>The <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> emitting the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to the affected node.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>The <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> proxying the added session.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title='The "node-added" signal'>
<a name="InfdDirectory-node-added"></a><h3>The <code class="literal">"node-added"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>     *directory,
                                                        <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>           user_data)      : Run Last</pre>
<p>
This signal is emitted when a new node has been created. It can either
be created by API calls such as <a class="link" href="InfdDirectory.html#infd-directory-add-note" title="infd_directory_add_note ()"><code class="function">infd_directory_add_note()</code></a> and
<a class="link" href="InfdDirectory.html#infd-directory-add-subdirectory" title="infd_directory_add_subdirectory ()"><code class="function">infd_directory_add_subdirectory()</code></a> or by a client making a corresponding
request.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>The <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> emitting the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to the added node.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title='The "node-removed" signal'>
<a name="InfdDirectory-node-removed"></a><h3>The <code class="literal">"node-removed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>     *directory,
                                                        <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>           user_data)      : Run Last</pre>
<p>
This signal is emitted when a node has been removed. If a subdirectory
node is removed, all contained nodes are removed as well. Node removal
can either happen through a call to <a class="link" href="InfdDirectory.html#infd-directory-remove-node" title="infd_directory_remove_node ()"><code class="function">infd_directory_remove_node()</code></a>, or by
a client making a corresponding request.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>The <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> emitting the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to the removed node.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title='The "remove-session" signal'>
<a name="InfdDirectory-remove-session"></a><h3>The <code class="literal">"remove-session"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>     *directory,
                                                        <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> *iter,
                                                        <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a>  *session,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>           user_data)      : Run Last</pre>
<p>
This signal is emitted when a previously added session was removed. This
happens when a session is idle for some time, or when the corresponding
node has been removed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>The <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> emitting the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="InfdDirectory.html#InfdDirectoryIter" title="InfdDirectoryIter"><span class="type">InfdDirectoryIter</span></a> pointing to the affected node.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>The <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> proxying the removed session.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="See Also">
<a name="InfdDirectory.see-also"></a><h2>See Also</h2>
<a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a>, <a class="link" href="libinfinity-0.4-infd-storage.html#InfdStorage"><span class="type">InfdStorage</span></a>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>